== How to Use Boutique ==

This document gives some advice to end users about how to use Boutique. You may
wish to copy and paste this information onto your server's website, but since
Boutique is reasonably configurable, it may not provide enough information. Feel 
free to edit the information contained in this document before pasting it, and
you needn't bother to list me as an author either. (The plugin is released under
a rather strict license because I can't be bothered to research different
licenses, so I feel obligated to say that last sentence.)

The document is organised into talking about useful commands for everyone, for
buyers, and then sellers. It must not be thought that "buyer" and "seller" are
classes that are picked by players, it is simply a way to explain how to use the
plugin.
The next section talks about admins, and the final section lists the commands

=== Everyone ===
Use /shopcommands to get a list of commands for the plugin

=== Buyers ===
There are four useful commands:

      /shoplist
      /shopgo [user]

/shoplist gives you a list of shops, and a description of each of these shops.
In some configurations, and/or if the list is heavily populated, the description
will be omitted.

/shopgo [user] may allow you to teleport to the shop belonging to [user],
depending on the configuration options set by your admin. This command may
instead send a request to the owner of the shop, and they will decide whether
you are allowed to teleport there. You will be teleported there if they decide
to accecpt your request. Under some configurations, teleporting may be disabled
completely.

=== Sellers ===
There are as many as six useful commands:

      /shopregister
      /shopopen
      /shopclose
      /shop
      /shopaccept
      /shopdeny.

To create a shop, use /shopregister [description]. You may have only one shop at
a time, and each time you use /shopregister, your previous shop's details will
be overwritten. [description] is optional, but may help distinguish your shop
from your competitors when a potential customer views the list of shops. When
your shop is created with /shopregister, your shop will be set automatically to
"closed".

Your shop can be opened and closed using /shopopen and /shopclose respectively.
Depending on the configuration on your server, this may change whether you
appear in the shoplist, or whether and how people can teleport to your shop.

/shop may allow you to teleport to your own shop, depending on the
configuration options set by your admin

Finally, /shopaccept and /shopdeny are the commands used accept or deny a 
teleport request to your shop. You will only need to use these when a message
appears on-screen informing you of the choice. On some configurations, these
commands will never need to be used because request teleporting may not be
enabled.

===  Admins ===
Administrators have no special privileges in Boutique so far. There are two
ways that the plugin can be used: posting objectionable content in the
[description] of one's shop, and setting up a spawn trap at the teleportation
place. Both of these problems may be solved by booting the player from the
server, but only as long as the shop list is configured not to show players who
are offline. If you do wish to show these shops, your only recourse is to
manually remove the offending lines from the database. This should be safe, but
I have to recommend, to eschew legal responsibility, that you backup everything
before deleting lines manually from the database. Take further precaution by
turning the minecraft server off before doing this.

=== Commands ===
/shoplist
 - Displays a list of shops
/shopgo [username]
 - telelport to [username]'s shop
/shopregister [description]
 - register a shop with [description], or update your shop
/shopopen
 - open your shop
/shopclose
 - close your shop (details are kept so that you may open it again at any time)
/shop
 - teleport to your shop
/shopaccept
 - accept a request for a user to teleport to your shop
/shopdeny
 - deny a request for a user to teleport to your shop
/shopcommands
 - display a list of commands

